Skip to content

docs: add comprehensive configuration reference and usage guides#36

Merged
zTgx merged 1 commit intomainfrom
dev
Apr 10, 2026
Merged

docs: add comprehensive configuration reference and usage guides#36
zTgx merged 1 commit intomainfrom
dev

Conversation

@zTgx
Copy link
Copy Markdown
Member

@zTgx zTgx commented Apr 10, 2026

  • Add detailed configuration reference documentation covering all configuration layers, environment variables, and TOML file options including LLM settings, retry mechanisms, fallback strategies, retrieval configurations, and metrics tracking

  • Create Python usage guide with installation instructions, configuration methods (zero config, custom settings, config files), indexing examples from various sources (files, content, bytes), querying techniques, and document management operations

  • Develop Rust usage guide featuring engine builder patterns, multiple configuration approaches (presets, custom endpoints), indexing workflows with different input types and options, advanced querying with retrieve options and strategy preferences, streaming capabilities, and document graph functionality

  • Include comprehensive examples section for both Python and Rust with links to example repositories demonstrating various use cases

- Add detailed configuration reference documentation covering all
  configuration layers, environment variables, and TOML file options
  including LLM settings, retry mechanisms, fallback strategies,
  retrieval configurations, and metrics tracking

- Create Python usage guide with installation instructions,
  configuration methods (zero config, custom settings, config files),
  indexing examples from various sources (files, content, bytes),
  querying techniques, and document management operations

- Develop Rust usage guide featuring engine builder patterns,
  multiple configuration approaches (presets, custom endpoints),
  indexing workflows with different input types and options,
  advanced querying with retrieve options and strategy preferences,
  streaming capabilities, and document graph functionality

- Include comprehensive examples section for both Python and Rust
  with links to example repositories demonstrating various use cases
@zTgx zTgx merged commit b4eae12 into main Apr 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant